The TimeLine<(Of <(<'ValueType>)>)> type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| TimeLine<(Of <(<'ValueType>)>)> |
Create an instance of a TimeLine object with the specified name
and subscribe to update for the TimeLine
|
Methods
| Name | Description | |
|---|---|---|
| ByteArrayToValue |
Convert a byte array back to a value
| |
| Clear |
Removes all values from at timeline (only the local copy)
| |
| Difference |
Difference between 2 time line values
Default behaviour is to always return a large value
| |
| Disconnect |
Disconnects the time line from the subscription list
| |
| Equals | (Inherited from Object.) | |
| Finalize | (Inherited from Object.) | |
| Get |
Returns a value for the given time. Producing this value may require interpolation
or extrapolation.
| |
| GetHashCode | (Inherited from Object.) | |
| GetRange |
Returns a list of values for the given time range.
| |
| GetType | (Inherited from Object.) | |
| MemberwiseClone | (Inherited from Object.) | |
| NextTime |
Returns the next ground time after the given time.
If there is no future ground time, returns t.
| |
| PrevTime |
Returns the next ground time before the given time.
If there is no past ground time, returns t.
| |
| Ready |
Returns true if the timeline is ready to be used. i.e. there is at
least one value in the timeline
| |
| Reconnect |
Adds an existing time line to the subscription list
| |
| Set(Int32, ValueType) |
Sets the value of the time line at time t. Any previously set values
later than t are removed.
| |
| Set(Int32, ValueType, Boolean) |
Sets the value of the time line at time t. Any previously set values
later than t are removed.
| |
| SetExtrapolationType |
Sets the extrapolation delegate to be used
| |
| SetFromRemote |
Used to update a value from a remote time line. The remote time is in real time, not
relative time, so must be converted to relative time before saving.
| |
| SetId |
Set the unique id for the timeline
| |
| SetInterpolationType |
Sets the interpolation delegate to be used
| |
| ToString | (Inherited from Object.) | |
| ValueAfter |
Returns the element following this one.
| |
| ValueAt |
Returns the value at time t, if there is one; otherwise returns null.
| |
| ValueBefore(Int32) |
Returns the element with latest time before the given time.
Returns null is there is no such element.
| |
| ValueBefore(Int32, Boolean) |
Returns the element with latest time before the given time.
Returns null is there is no such element.
| |
| ValueBeforeAt |
Returns the element with latest time before or at the given time.
Returns null is there is no such element.
| |
| ValueToByteArray |
Convert a value to a byte array for sending over the network
|
Fields
| Name | Description | |
|---|---|---|
| Extrapolate |
A delegate is used to specify the extrapolation method
| |
| Interpolate |
A delegate is used to specify the interpolation method
| |
| linear |
Constant used for specifying the interpolation or extrapolation type
| |
| Name |
Name of the time line
| |
| quadratic |
Constant used for specifying the interpolation or extrapolation type
| |
| stepping |
Constant used for specifying the interpolation or extrapolation type
|
Properties
| Name | Description | |
|---|---|---|
| BufferSize |
Number of messages buffered on the TimeLineServer
| |
| ExtrapolationType |
Extrapolation method to use when getting values
| |
| InterpolationType |
Interpolation method to use when getting values
| |
| MaximumLength |
Maximum number of values to store in the time line
| |
| MinSendMS |
Minimum time between sending messages to remote
| |
| SendAllValues |
If true forces all values that are set in the timeline to be broadcast
| |
| Tolerance |
Difference between extrapolated value on remote sites and
the value on local sites causing the value to be sent to remote sites
|
Events
| Name | Description | |
|---|---|---|
| RemoteSet |
Create an event based on the RemoteSetHandler delegate
|